<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /fasttmp/mkdist-qt-4.3.5-1211793125/qtopia-core-opensource-src-4.3.5/src/corelib/tools/qmap.cpp -->
<head>
  <title>Qt 4.3: QMap::const_iterator Class Reference</title>
  <link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QMap::const_iterator Class Reference<br /><sup><sup>[<a href="qtcore.html">QtCore</a> module]</sup></sup></h1>
<p>The QMap::const_iterator class provides an STL-style const iterator for <a href="qmap.html">QMap</a> and <a href="qmultimap.html">QMultiMap</a>. <a href="#details">More...</a></p>
<pre> #include &lt;<a href="qmap.html">QMap</a>&gt;</pre><ul>
<li><a href="qmap-const-iterator-members.html">List of all members, including inherited members</a></li>
<li><a href="qmap-const-iterator-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qmap-const-iterator.html#const_iterator">const_iterator</a></b> ()</li>
<li><div class="fn"/><b><a href="qmap-const-iterator.html#const_iterator-3">const_iterator</a></b> ( const iterator &amp; <i>other</i> )</li>
<li><div class="fn"/>const Key &amp; <b><a href="qmap-const-iterator.html#key">key</a></b> () const</li>
<li><div class="fn"/>const T &amp; <b><a href="qmap-const-iterator.html#value">value</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qmap-const-iterator.html#operator-not-eq">operator!=</a></b> ( const const_iterator &amp; <i>other</i> ) const</li>
<li><div class="fn"/>const T &amp; <b><a href="qmap-const-iterator.html#operator-2a">operator*</a></b> () const</li>
<li><div class="fn"/>const_iterator <b><a href="qmap-const-iterator.html#operator-2b">operator+</a></b> ( int <i>j</i> ) const</li>
<li><div class="fn"/>const_iterator &amp; <b><a href="qmap-const-iterator.html#operator-2b-2b">operator++</a></b> ()</li>
<li><div class="fn"/>const_iterator <b><a href="qmap-const-iterator.html#operator-2b-2b-2">operator++</a></b> ( int )</li>
<li><div class="fn"/>const_iterator &amp; <b><a href="qmap-const-iterator.html#operator-2b-eq">operator+=</a></b> ( int <i>j</i> )</li>
<li><div class="fn"/>const_iterator <b><a href="qmap-const-iterator.html#operator-">operator-</a></b> ( int <i>j</i> ) const</li>
<li><div class="fn"/>const_iterator &amp; <b><a href="qmap-const-iterator.html#operator--">operator--</a></b> ()</li>
<li><div class="fn"/>const_iterator <b><a href="qmap-const-iterator.html#operator---2">operator--</a></b> ( int )</li>
<li><div class="fn"/>const_iterator &amp; <b><a href="qmap-const-iterator.html#operator--eq">operator-=</a></b> ( int <i>j</i> )</li>
<li><div class="fn"/>const T * <b><a href="qmap-const-iterator.html#operator--gt">operator-&gt;</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qmap-const-iterator.html#operator-eq-eq">operator==</a></b> ( const const_iterator &amp; <i>other</i> ) const</li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QMap::const_iterator class provides an STL-style const iterator for <a href="qmap.html">QMap</a> and <a href="qmultimap.html">QMultiMap</a>.</p>
<p><a href="qmap.html">QMap</a> features both <a href="containers.html#stl-style-iterators">STL-style iterators</a> and <a href="containers.html#java-style-iterators">Java-style iterators</a>. The STL-style iterators are more low-level and more cumbersome to use; on the other hand, they are slightly faster and, for developers who already know STL, have the advantage of familiarity.</p>
<p><a href="qmap.html">QMap</a>&lt;Key, T&gt;::const_iterator allows you to iterate over a <a href="qmap.html">QMap</a> (or a <a href="qmultimap.html">QMultiMap</a>). If you want to modify the <a href="qmap.html">QMap</a> as you iterate over it, you must use <a href="qmap-iterator.html">QMap::iterator</a> instead. It is generally good practice to use QMap::const_iterator on a non-const <a href="qmap.html">QMap</a> as well, unless you need to change the <a href="qmap.html">QMap</a> through the iterator. Const iterators are slightly faster, and can improve code readability.</p>
<p>The default QMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using a <a href="qmap.html">QMap</a> function like <a href="qmap.html#constBegin">QMap::constBegin</a>(), <a href="qmap.html#constEnd">QMap::constEnd</a>(), or <a href="qmap.html#find">QMap::find</a>() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map:</p>
<pre> QMap&lt;QString, int&gt; map;
 map.insert(&quot;January&quot;, 1);
 map.insert(&quot;February&quot;, 2);
 ...
 map.insert(&quot;December&quot;, 12);

 QMap&lt;QString, int&gt;::const_iterator i;
 for (i = map.constBegin(); i != map.constEnd(); ++i)
     cout &lt;&lt; i.key() &lt;&lt; &quot;: &quot; &lt;&lt; i.value() &lt;&lt; endl;</pre>
<p>Unlike <a href="qhash.html">QHash</a>, which stores its items in an arbitrary order, <a href="qmap.html">QMap</a> stores its items ordered by key. Items that share the same key (because they were inserted using <a href="qmap.html#insertMulti">QMap::insertMulti</a>()) will appear consecutively, from the most recently to the least recently inserted value.</p>
<p>Multiple iterators can be used on the same map. If you add items to the map, existing iterators will remain valid. If you remove items from the map, iterators that point to the removed items will become dangling iterators.</p>
<p>See also <a href="qmap-iterator.html">QMap::iterator</a> and <a href="qmapiterator.html">QMapIterator</a>.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="const_iterator"></a>const_iterator::const_iterator ()</h3>
<p>Constructs an uninitialized iterator.</p>
<p>Functions like <a href="qmap-const-iterator.html#key">key</a>(), <a href="qmap-const-iterator.html#value">value</a>(), and operator++() must not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.</p>
<p>See also <a href="qmap.html#constBegin">QMap::constBegin</a>() and <a href="qmap.html#constEnd">QMap::constEnd</a>().</p>
<h3 class="fn"><a name="const_iterator-3"></a>const_iterator::const_iterator ( const <a href="qmap-iterator.html">iterator</a> &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>.</p>
<h3 class="fn"><a name="key"></a>const Key &amp; const_iterator::key () const</h3>
<p>Returns the current item's key.</p>
<p>See also <a href="qmap-const-iterator.html#value">value</a>().</p>
<h3 class="fn"><a name="value"></a>const T &amp; const_iterator::value () const</h3>
<p>Returns the current item's value.</p>
<p>See also <a href="qmap-const-iterator.html#key">key</a>() and <a href="qmap-const-iterator.html#operator-2a">operator*</a>().</p>
<h3 class="fn"><a name="operator-not-eq"></a>bool const_iterator::operator!= ( const const_iterator &amp; <i>other</i> ) const</h3>
<p>Returns true if <i>other</i> points to a different item than this iterator; otherwise returns false.</p>
<p>See also <a href="qmap-const-iterator.html#operator-eq-eq">operator==</a>().</p>
<h3 class="fn"><a name="operator-2a"></a>const T &amp; const_iterator::operator* () const</h3>
<p>Returns the current item's value.</p>
<p>Same as <a href="qmap-const-iterator.html#value">value</a>().</p>
<p>See also <a href="qmap-const-iterator.html#key">key</a>().</p>
<h3 class="fn"><a name="operator-2b"></a>const_iterator const_iterator::operator+ ( int <i>j</i> ) const</h3>
<p>Returns an iterator to the item at <i>j</i> positions forward from this iterator. (If <i>j</i> is negative, the iterator goes backward.)</p>
<p>This operation can be slow for large <i>j</i> values.</p>
<p>See also <a href="qmap-const-iterator.html#operator-">operator-</a>().</p>
<h3 class="fn"><a name="operator-2b-2b"></a>const_iterator &amp; const_iterator::operator++ ()</h3>
<p>The prefix ++ operator (<tt>++i</tt>) advances the iterator to the next item in the map and returns an iterator to the new current item.</p>
<p>Calling this function on <a href="qmap.html#end">QMap::end</a>() leads to undefined results.</p>
<p>See also <a href="qmap-const-iterator.html#operator--">operator--</a>().</p>
<h3 class="fn"><a name="operator-2b-2b-2"></a>const_iterator const_iterator::operator++ ( int )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>The postfix ++ operator (<tt>i++</tt>) advances the iterator to the next item in the map and returns an iterator to the previously current item.</p>
<h3 class="fn"><a name="operator-2b-eq"></a>const_iterator &amp; const_iterator::operator+= ( int <i>j</i> )</h3>
<p>Advances the iterator by <i>j</i> items. (If <i>j</i> is negative, the iterator goes backward.)</p>
<p>This operation can be slow for large <i>j</i> values.</p>
<p>See also <a href="qmap-const-iterator.html#operator--eq">operator-=</a>() and <a href="qmap-const-iterator.html#operator-2b">operator+</a>().</p>
<h3 class="fn"><a name="operator-"></a>const_iterator const_iterator::operator- ( int <i>j</i> ) const</h3>
<p>Returns an iterator to the item at <i>j</i> positions backward from this iterator. (If <i>j</i> is negative, the iterator goes forward.)</p>
<p>This operation can be slow for large <i>j</i> values.</p>
<p>See also <a href="qmap-const-iterator.html#operator-2b">operator+</a>().</p>
<h3 class="fn"><a name="operator--"></a>const_iterator &amp; const_iterator::operator-- ()</h3>
<p>The prefix -- operator (<tt>--i</tt>) makes the preceding item current and returns an iterator pointing to the new current item.</p>
<p>Calling this function on <a href="qmap.html#begin">QMap::begin</a>() leads to undefined results.</p>
<p>See also <a href="qmap-const-iterator.html#operator-2b-2b">operator++</a>().</p>
<h3 class="fn"><a name="operator---2"></a>const_iterator const_iterator::operator-- ( int )</h3>
<p>This is an overloaded member function, provided for convenience.</p>
<p>The postfix -- operator (<tt>i--</tt>) makes the preceding item current and returns an iterator pointing to the previously current item.</p>
<h3 class="fn"><a name="operator--eq"></a>const_iterator &amp; const_iterator::operator-= ( int <i>j</i> )</h3>
<p>Makes the iterator go back by <i>j</i> items. (If <i>j</i> is negative, the iterator goes forward.)</p>
<p>This operation can be slow for large <i>j</i> values.</p>
<p>See also <a href="qmap-const-iterator.html#operator-2b-eq">operator+=</a>() and <a href="qmap-const-iterator.html#operator-">operator-</a>().</p>
<h3 class="fn"><a name="operator--gt"></a>const T * const_iterator::operator-&gt; () const</h3>
<p>Returns a pointer to the current item's value.</p>
<p>See also <a href="qmap-const-iterator.html#value">value</a>().</p>
<h3 class="fn"><a name="operator-eq-eq"></a>bool const_iterator::operator== ( const const_iterator &amp; <i>other</i> ) const</h3>
<p>Returns true if <i>other</i> points to the same item as this iterator; otherwise returns false.</p>
<p>See also <a href="qmap-const-iterator.html#operator-not-eq">operator!=</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.3.5</div></td>
</tr></table></div></address></body>
</html>
